Navigation rail
Type
widget
Summary
A widget that can be used as a horizontal or vertical navigation rail, with a menu button, a floating action button (FAB), and various destination buttons.
Description
A widget that can be used as a horizontal or vertical navigation rail, with a menu button, a floating action button (FAB), and various destination buttons.
Children Properties
Message
| Name | Summary | Syntax |
|---|---|---|
| mouseUp | Sent when the navigation rail is clicked | mouseUp pButton, pEventInfo |
| hiliteChanged | Sent when the hilited destination of the navigation rail changes | hiliteChanged pNewIndex, pOldIndex |
Property
| Name | Summary | Syntax |
|---|---|---|
| fabIcon | Specifies icon of the FAB. | set the fabIcon of widget to <RGBA Color> get the fabIcon of widget |
| indicatorColor | Specifies color of the indicator. | set the indicatorColor of widget to <RGBA Color> get the indicatorColor of widget |
| destinationCornerRadius | The radius of the destination button corners | set the destinationCornerRadius of widget to <Number> get the destinationCornerRadius of widget |
| showFab | Whether to show the FAB or not | set the showFab of widget to { true | false } get the showFab of widget |
| fabIconHoverColor | Specifies the icon hover color of the FAB. | set the fabIconHoverColor of widget to <RGBA Color> get the fabIconHoverColor of widget |
| showMenuIcon | Determine if the menu icon is shown | set the showMenuIcon of widget to <Boolean> get the showMenuIcon of widget |
| hilitedItemIndex | The index of the currently selected navigation item | set the hilitedItemIndex of widget to <Number> get the hilitedItemIndex of widget |
| destinationLabelHiliteColor | Specifies the Label color of the destination elements when hilited. | set the destinationLabelHiliteColor of widget to <RGBA Color> get the destinationLabelHiliteColor of widget |
| destinationIconHoverColor | Specifies the icon color of the destination elements when hovering. | set the destinationIconHoverColor of widget to <RGBA Color> get the destinationIconHoverColor of widget |
| fabColor | Specifies the background color of the FAB. | set the fabColor of widget to <RGBA Color> get the fabColor of widget |
| dividerWidth | Specifies width of the divider. | set the dividerWidth of widget to <RGBA Color> get the dividerWidth of widget |
| destinationsOffset | The destinations offset | set the destinationsOffset of widget to <Number> get the destinationsOffset of widget |
| margin | The margin | set the margin of widget to <Number> get the margin of widget |
| fabIconHiliteColor | Specifies the hilited icon color of the FAB. | set the fabIconHiliteColor of widget to <RGBA Color> get the fabIconHiliteColor of widget |
| labelVisibility | Determines when a destination label is shown | set the labelVisibility of widget to { true | false } get the labelVisibility of widget |
| fabHiliteColor | Specifies the hilite color of the FAB. | set the fabHiliteColor of widget to <RGBA Color> get the fabHiliteColor of widget |
| destinationIconHiliteColor | Specifies the icon color of the destination elements when hilited. | set the destinationIconHiliteColor of widget to <RGBA Color> get the destinationIconHiliteColor of widget |
| destinationIconSize | The size of a destination icon | set the destinationIconSize of widget to <Number> get the destinationIconSize of widget |
| fabCornerRadius | The radius of the FAB corners | set the fabCornerRadius of widget to <Number> get the fabCornerRadius of widget |
| useIndicator | Whether the active destination shows an indicator | set the useIndicator of widget to <Boolean> get the useIndicator of widget |
| fabHoverColor | Specifies the hover color of the FAB. | set the fabHoverColor of widget to <RGBA Color> get the fabHoverColor of widget |
| destinationIconColor | Specifies the icon color of the destination elements. | set the destinationIconColor of widget to <RGBA Color> get the destinationIconColor of widget |
| dividerColor | Specifies color of the divider. | set the dividerColor of widget to <RGBA Color> get the dividerColor of widget |
| destinationLabelColor | Specifies the Label color of the destination elements. | set the destinationLabelColor of widget to <RGBA Color> get the destinationLabelColor of widget |
| fabLocation | The position of the FAB. | set the fabLocation of widget to <String> get the fabLocation of widget |
| destinationsAlignment | How to position the destinations group. | set the destinationsAlignment of widget to <String> get the destinationsAlignment of widget |
| hilitedItemName | The name of the currently selected navigation item | set the hilitedItemName of widget to <Number> get the hilitedItemName of widget |
| trailingSpace | The trailing space | set the trailingSpace of widget to <Number> get the trailingSpace of widget |
| leadingSpace | The leading Space | set the leadingSpace of widget to <Number> get the leadingSpace of widget |
| dividerLocation | The position of the divider. | set the dividerLocation of widget to <String> get the dividerLocation of widget |
| destinationLabelHoverColor | Specifies the Label color of the destination elements when hovering. | set the destinationLabelHoverColor of widget to <RGBA Color> get the destinationLabelHoverColor of widget |
| menuCornerRadius | The radius of the menu button corners | set the menuCornerRadius of widget to <Number> get the menuCornerRadius of widget |
| fabIconColor | Specifies the icon color of the FAB. | set the fabIconColor of widget to <RGBA Color> get the fabIconColor of widget |
| content | The content | set the content of widget to <Number> get the content of widget |
| allowDeselect | Determine if the user can deselect navigation items | set the allowDeselect of widget to <Boolean> get the allowDeselect of widget |